-
Notifications
You must be signed in to change notification settings - Fork 4k
GH-33619: [Documentation] Update PR template #33620
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GH-33619: [Documentation] Update PR template #33620
Conversation
|
|
|
|
|
Looks good to me! Thanks for making this change, @assignUser! Following up on the discussion about stripping comments from the pull request description when merging, I believe adding the following around line 583 of if self.body is not None:
# Remove comments (i.e. <-- comment -->) from the pull request description.
body = re.sub(r"<--.*-->", "", self.body)
# avoid github user name references by inserting a space after @
body = re.sub(r"@(\w+)", "@ \\1", body)
commit_message_chunks.append(body)Of course, there is a chance that a contributor might intend to include a literal use of |
Short term that would be good to do to avoid those long noisy commit messages. Longer term, IMO we should discuss using only the title of the PR. |
| --> | ||
|
|
||
| # Are there any user-facing changes? | ||
| ### Are there any user-facing changes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another piece of feedback:
- The
breaking-changelabel didn't exist. I decided to add it asBreaking Changejust now, since there isn't a good reason to kebab-case AFAIK. - I don't think non-committers can apply labels, right? So perhaps the instructions simply need to have a checkbox
[ ] This PR contains breaking changesor something like that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I'll handle this in #33660
jorisvandenbossche
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is already a big improvement IMO, so let's merge this
|
Whoops, sorry, the linter was failing on the code line in archery .. This will be fixed by #15067 |
|
Benchmark runs are scheduled for baseline = 7d3bca3 and contender = 7e6bcd1. 7e6bcd1 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Rationale for this change
I will keep this as a draft for now please feel free to suggest additional changes!
What changes are included in this PR?
I have switched to smaller headers for now and removed the first head + closes keyword to avoid redundancy.